GSK: Fix a bunch of warnings from the GIR scanner
authorDaniel Boles <dboles@src.gnome.org>
Mon, 27 Mar 2017 19:13:15 +0000 (20:13 +0100)
committerDaniel Boles <dboles@src.gnome.org>
Mon, 27 Mar 2017 19:22:07 +0000 (20:22 +0100)
arising from conflicting argument names, missing annotations, etc.

gsk/gskrenderer.c
gsk/gskrendernode.h
gsk/gskrendernodeimpl.c
gsk/gskroundedrect.c
gsk/gskroundedrect.h

index adc504053a5c989058ee11c4a23753016aef2c7b..35747c9820ab1de68c4771020e6b626f5fa93af9 100644 (file)
@@ -849,7 +849,7 @@ static struct {
 
 /**
  * gsk_renderer_new_for_window:
- * @display: a #GdkDisplay
+ * @window: a #GdkWindow
  *
  * Creates an appropriate #GskRenderer instance for the given @window.
  *
@@ -922,6 +922,19 @@ gsk_renderer_create_cairo_surface (GskRenderer    *renderer,
   return GSK_RENDERER_GET_CLASS (renderer)->create_cairo_surface (renderer, format, width, height);
 }
 
+/**
+ * gsk_renderer_begin_draw_frame:
+ * @renderer: a #GskRenderer
+ * @region: the #cairo_region_t that you wish to draw
+ *
+ * Indicates that you are beginning the process of redrawing @region using
+ * @renderer, and provides you with a #GdkDrawingContext to use for this.
+ *
+ * Returns: (transfer none): a #GdkDrawingContext context that should be used to
+ * draw the contents of the @renderer. This context is owned by GDK.
+ *
+ * Since: 3.90
+ */
 GdkDrawingContext *
 gsk_renderer_begin_draw_frame (GskRenderer          *renderer,
                                const cairo_region_t *region)
index f46c283ba1837ff26222fb55e467e9ab163ebe27..08bb87d0b043543f49332b304cc41959dbe9f52c 100644 (file)
@@ -183,7 +183,7 @@ GDK_AVAILABLE_IN_3_90
 const char *            gsk_render_node_get_name                (GskRenderNode *node);
 GDK_AVAILABLE_IN_3_90
 void                    gsk_render_node_get_bounds              (GskRenderNode   *node,
-                                                                 graphene_rect_t *frame);
+                                                                 graphene_rect_t *bounds);
 
 GDK_AVAILABLE_IN_3_90
 void                    gsk_render_node_draw                    (GskRenderNode *node,
index 7827ece4b4ebc6b648615159b0e7cf20ef8dd153..0dac4ff867c65028fdb77a086755d465a37b4f74 100644 (file)
@@ -123,7 +123,7 @@ gsk_color_node_peek_color (GskRenderNode *node)
 
 /**
  * gsk_color_node_new:
- * @color: the #GskColor
+ * @rgba: the #GskColor
  * @bounds: the rectangle to render the color into
  *
  * Creates a #GskRenderNode that will render the given
@@ -303,11 +303,14 @@ static const GskRenderNodeClass GSK_REPEATING_LINEAR_GRADIENT_NODE_CLASS = {
 
 /**
  * gsk_linear_gradient_node_new:
- * @linear_gradient: the #GskLinearGradient
- * @bounds: the rectangle to render the linear_gradient into
+ * @bounds: the rectangle to render the linear gradient into
+ * @start: the point at which the linear gradient will begin
+ * @end: the point at which the linear gradient will finish
+ * @color_stops: a pointer to an array of #GskColorStop defining the gradient
+ * @n_color_stops: the number of elements in @color_stops
  *
- * Creates a #GskRenderNode that will render the given
- * @linear_gradient into the area given by @bounds.
+ * Creates a #GskRenderNode that will create a linear gradient from the given
+ * points and color stops, and render that into the area given by @bounds.
  *
  * Returns: A new #GskRenderNode
  *
@@ -2818,7 +2821,7 @@ static const GskRenderNodeClass GSK_REPEAT_NODE_CLASS = {
  * gsk_repeat_node_new:
  * @bounds: The bounds of the area to be painted
  * @child: The child to repeat
- * @child_bounds: (optional): The area of the child to repeat or %NULL to
+ * @child_bounds: (allow-none): The area of the child to repeat or %NULL to
  *     use the child's bounds
  *
  * Creates a #GskRenderNode that will repeat the drawing of @child across
index c381e479111807f9c6f352912538bf628211f18e..a1279a79385debe9e3a28f5b98d2ff1918cfde2a 100644 (file)
@@ -179,8 +179,8 @@ gsk_rounded_rect_normalize (GskRoundedRect *self)
 /**
  * gsk_rounded_rect_offset:
  * @self: a #GskRoundedRect
- * @d_x: the horizontal offset
- * @d_y: the vertical offset
+ * @dx: the horizontal offset
+ * @dy: the vertical offset
  *
  * Offsets the bound's origin by @dx and @dy.
  *
@@ -222,7 +222,7 @@ border_radius_shrink (graphene_size_t *corner,
 
 /**
  * gsk_rounded_rect_shrink:
- * @self: The @GskRoundedRect to shrink or grow
+ * @self: The #GskRoundedRect to shrink or grow
  * @top: How far to move the top side downwards
  * @right: How far to move the right side to the left
  * @bottom: How far to move the bottom side upwards
@@ -236,7 +236,7 @@ border_radius_shrink (graphene_size_t *corner,
  * This function also works for growing rectangles if you pass
  * negative values for the @top, @right, @bottom or @left.
  *
- * Returns: @self
+ * Returns: (transfer none): the resized #GskRoundedRect
  **/
 GskRoundedRect *
 gsk_rounded_rect_shrink (GskRoundedRect *self,
@@ -275,7 +275,7 @@ gsk_rounded_rect_shrink (GskRoundedRect *self,
   return self;
 }
 
-/* XXX: Fina a better name */
+/* XXX: Find a better name */
 gboolean
 gsk_rounded_rect_is_circular (const GskRoundedRect *self)
 {
index 98819e4ea3ab88d7174de78de2d1c39f3b2bfae4..d12156cb24ec61d43a8d7ec5f34d175a41e66f0f 100644 (file)
@@ -67,7 +67,7 @@ struct _GskRoundedRect
 
 GDK_AVAILABLE_IN_3_90
 GskRoundedRect *        gsk_rounded_rect_init                   (GskRoundedRect           *self,
-                                                                 const graphene_rect_t    *rect,
+                                                                 const graphene_rect_t    *bounds,
                                                                  const graphene_size_t    *top_left,
                                                                  const graphene_size_t    *top_right,
                                                                  const graphene_size_t    *bottom_right,